Documentação - Documentação

post https://billing.iugu.com/api/customers/{id}/credits

Adiciona crédito ao saldo de uma assinatura do cliente

Adiciona crédito ao saldo da assinatura ativa do cliente no app que está fazendo a chamada.

O crédito é atribuído diretamente à assinatura, e não a uma fatura: ele fica disponível como saldo e é consumido automaticamente pela fatura em aberto da assinatura.
A assinatura é identificada pelo cliente informado no path e pelo app do token, sem necessidade de informá-la no corpo da requisição.

Permissão necessária: billing:customers.credits.create

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Request

Path variables
id Required Type: string Identificador do workspace do cliente Ex: 4fHECmQtLdROI4fDLWMiLd

Headers
workspace_id Required Type: string Identificador do workspace Ex: 4fHECmQtLdROI4fDLWMiLd

Body Required

Content Type: application/json

amount

Required

Number

Valor do crédito a ser adicionado

Ex: 100.5

Example

1
2
3
{
  "amount": 100.5
}

Response

201

Crédito adicionado com sucesso

success

Boolean

Ex: true

credit_id

String

Identificador do lançamento de crédito

Ex: 1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d

subscription_id

String

Assinatura creditada

Ex: 9c2f1f6e-1f0a-4a4c-9a3f-0d1b2c3d4e5f

amount

Number

Valor do crédito adicionado

Ex: 100.5

balance

Number

Saldo da assinatura após o lançamento

Ex: 150.75

Example

1
2
3
4
5
6
7
{
  "success": true,
  "credit_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "subscription_id": "9c2f1f6e-1f0a-4a4c-9a3f-0d1b2c3d4e5f",
  "amount": 100.5,
  "balance": 150.75
}

401

Quando houver erro de autenticação

errors

String

Mensagem de erro

Ex: Authentication Error, check your token and try again

Example

1
2
3
{
  "errors": "Authentication Error, check your token and try again"
}

404

Recurso não encontrado. Possíveis motivos: - Nenhum cliente encontrado para o workspace informado - Nenhuma assinatura ativa do cliente encontrada para o app que está chamando

errors

String

Mensagem de erro

Ex: Cheque o Workspace ID e tente novamente mais tarde

Example

1
2
3
{
  "errors": "Cheque o Workspace ID e tente novamente mais tarde"
}

422

Erro de validação. Possíveis motivos: - Valor do crédito inválido (menor ou igual a zero)

errors

String

Mensagem de erro

Ex: Cheque o Workspace ID e tente novamente mais tarde

Example

1
2
3
{
  "errors": "Cheque o Workspace ID e tente novamente mais tarde"
}

500

Em caso de erro de servidor ou externo.
Você deve tentar de novo dentro de alguns minutos.

errors

String

Mensagem de erro

Ex: Internal Server Error, please try again later.

Example

1
2
3
{
  "errors": "Internal Server Error, please try again later."
}

Back

Aplica um desconto nas faturas emitidas do cliente em uma competência